<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.dbcp;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.PrintWriter;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * Configuration settings for handling abandoned db connections.<a name="line.23"></a>
<FONT color="green">024</FONT>     *                                                            <a name="line.24"></a>
<FONT color="green">025</FONT>     * @author Glenn L. Nielsen           <a name="line.25"></a>
<FONT color="green">026</FONT>     * @version $Revision: 758745 $ $Date: 2009-03-26 13:02:20 -0400 (Thu, 26 Mar 2009) $<a name="line.26"></a>
<FONT color="green">027</FONT>     */<a name="line.27"></a>
<FONT color="green">028</FONT>    public class AbandonedConfig {<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>        /**<a name="line.30"></a>
<FONT color="green">031</FONT>         * Whether or not a connection is considered abandoned and eligible<a name="line.31"></a>
<FONT color="green">032</FONT>         * for removal if it has been idle longer than the removeAbandonedTimeout<a name="line.32"></a>
<FONT color="green">033</FONT>         */<a name="line.33"></a>
<FONT color="green">034</FONT>        private boolean removeAbandoned = false;<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>        /**<a name="line.36"></a>
<FONT color="green">037</FONT>         * Flag to remove abandoned connections if they exceed the<a name="line.37"></a>
<FONT color="green">038</FONT>         * removeAbandonedTimeout.<a name="line.38"></a>
<FONT color="green">039</FONT>         *<a name="line.39"></a>
<FONT color="green">040</FONT>         * Set to true or false, default false.<a name="line.40"></a>
<FONT color="green">041</FONT>         * If set to true a connection is considered abandoned and eligible<a name="line.41"></a>
<FONT color="green">042</FONT>         * for removal if it has been idle longer than the removeAbandonedTimeout.<a name="line.42"></a>
<FONT color="green">043</FONT>         * Setting this to true can recover db connections from poorly written    <a name="line.43"></a>
<FONT color="green">044</FONT>         * applications which fail to close a connection.<a name="line.44"></a>
<FONT color="green">045</FONT>         *<a name="line.45"></a>
<FONT color="green">046</FONT>         * @return true if abandoned connections are to be removed<a name="line.46"></a>
<FONT color="green">047</FONT>         */<a name="line.47"></a>
<FONT color="green">048</FONT>        public boolean getRemoveAbandoned() {<a name="line.48"></a>
<FONT color="green">049</FONT>            return (this.removeAbandoned);<a name="line.49"></a>
<FONT color="green">050</FONT>        }<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Flag to remove abandoned connections if they exceed the<a name="line.53"></a>
<FONT color="green">054</FONT>         * removeAbandonedTimeout.<a name="line.54"></a>
<FONT color="green">055</FONT>         *<a name="line.55"></a>
<FONT color="green">056</FONT>         * Set to true or false, default false.<a name="line.56"></a>
<FONT color="green">057</FONT>         * If set to true a connection is considered abandoned and eligible   <a name="line.57"></a>
<FONT color="green">058</FONT>         * for removal if it has been idle longer than the removeAbandonedTimeout.<a name="line.58"></a>
<FONT color="green">059</FONT>         * Setting this to true can recover db connections from poorly written<a name="line.59"></a>
<FONT color="green">060</FONT>         * applications which fail to close a connection.<a name="line.60"></a>
<FONT color="green">061</FONT>         *<a name="line.61"></a>
<FONT color="green">062</FONT>         * @param removeAbandoned true means abandoned connections will be<a name="line.62"></a>
<FONT color="green">063</FONT>         *   removed<a name="line.63"></a>
<FONT color="green">064</FONT>         */<a name="line.64"></a>
<FONT color="green">065</FONT>        public void setRemoveAbandoned(boolean removeAbandoned) {<a name="line.65"></a>
<FONT color="green">066</FONT>            this.removeAbandoned = removeAbandoned;<a name="line.66"></a>
<FONT color="green">067</FONT>        }<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Timeout in seconds before an abandoned connection can be removed<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        private int removeAbandonedTimeout = 300;<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>        /**<a name="line.74"></a>
<FONT color="green">075</FONT>         * Timeout in seconds before an abandoned connection can be removed.<a name="line.75"></a>
<FONT color="green">076</FONT>         *<a name="line.76"></a>
<FONT color="green">077</FONT>         * Defaults to 300 seconds.<a name="line.77"></a>
<FONT color="green">078</FONT>         *<a name="line.78"></a>
<FONT color="green">079</FONT>         * @return abandoned timeout in seconds<a name="line.79"></a>
<FONT color="green">080</FONT>         */<a name="line.80"></a>
<FONT color="green">081</FONT>        public int getRemoveAbandonedTimeout() {<a name="line.81"></a>
<FONT color="green">082</FONT>            return (this.removeAbandonedTimeout);<a name="line.82"></a>
<FONT color="green">083</FONT>        }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /**<a name="line.85"></a>
<FONT color="green">086</FONT>         * Timeout in seconds before an abandoned connection can be removed.<a name="line.86"></a>
<FONT color="green">087</FONT>         *<a name="line.87"></a>
<FONT color="green">088</FONT>         * Defaults to 300 seconds.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @param removeAbandonedTimeout abandoned timeout in seconds<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        public void setRemoveAbandonedTimeout(int removeAbandonedTimeout) {<a name="line.92"></a>
<FONT color="green">093</FONT>            this.removeAbandonedTimeout = removeAbandonedTimeout;<a name="line.93"></a>
<FONT color="green">094</FONT>        }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /**<a name="line.96"></a>
<FONT color="green">097</FONT>         * Determines whether or not to log stack traces for application code<a name="line.97"></a>
<FONT color="green">098</FONT>         * which abandoned a Statement or Connection.<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        private boolean logAbandoned = false;<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /**<a name="line.102"></a>
<FONT color="green">103</FONT>         * Flag to log stack traces for application code which abandoned<a name="line.103"></a>
<FONT color="green">104</FONT>         * a Statement or Connection.<a name="line.104"></a>
<FONT color="green">105</FONT>         *<a name="line.105"></a>
<FONT color="green">106</FONT>         * Defaults to false.<a name="line.106"></a>
<FONT color="green">107</FONT>         * Logging of abandoned Statements and Connections adds overhead<a name="line.107"></a>
<FONT color="green">108</FONT>         * for every Connection open or new Statement because a stack<a name="line.108"></a>
<FONT color="green">109</FONT>         * trace has to be generated.<a name="line.109"></a>
<FONT color="green">110</FONT>         * <a name="line.110"></a>
<FONT color="green">111</FONT>         * @return boolean true if stack trace logging is turned on for abandoned<a name="line.111"></a>
<FONT color="green">112</FONT>         *  Statements or Connections<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         */<a name="line.114"></a>
<FONT color="green">115</FONT>        public boolean getLogAbandoned() {<a name="line.115"></a>
<FONT color="green">116</FONT>            return (this.logAbandoned);<a name="line.116"></a>
<FONT color="green">117</FONT>        }<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        /**<a name="line.119"></a>
<FONT color="green">120</FONT>         * Flag to log stack traces for application code which abandoned<a name="line.120"></a>
<FONT color="green">121</FONT>         * a Statement or Connection.<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * Defaults to false.<a name="line.123"></a>
<FONT color="green">124</FONT>         * Logging of abandoned Statements and Connections adds overhead<a name="line.124"></a>
<FONT color="green">125</FONT>         * for every Connection open or new Statement because a stack<a name="line.125"></a>
<FONT color="green">126</FONT>         * trace has to be generated.<a name="line.126"></a>
<FONT color="green">127</FONT>         * @param logAbandoned true turns on abandoned stack trace logging<a name="line.127"></a>
<FONT color="green">128</FONT>         *<a name="line.128"></a>
<FONT color="green">129</FONT>         */<a name="line.129"></a>
<FONT color="green">130</FONT>        public void setLogAbandoned(boolean logAbandoned) {<a name="line.130"></a>
<FONT color="green">131</FONT>            this.logAbandoned = logAbandoned;<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>        /**<a name="line.134"></a>
<FONT color="green">135</FONT>         * PrintWriter to use to log information on abandoned objects.<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        private PrintWriter logWriter = new PrintWriter(System.out);<a name="line.137"></a>
<FONT color="green">138</FONT>        <a name="line.138"></a>
<FONT color="green">139</FONT>        /**<a name="line.139"></a>
<FONT color="green">140</FONT>         * Returns the log writer being used by this configuration to log<a name="line.140"></a>
<FONT color="green">141</FONT>         * information on abandoned objects. If not set, a PrintWriter based on<a name="line.141"></a>
<FONT color="green">142</FONT>         * System.out is used.<a name="line.142"></a>
<FONT color="green">143</FONT>         *<a name="line.143"></a>
<FONT color="green">144</FONT>         * @return log writer in use<a name="line.144"></a>
<FONT color="green">145</FONT>         */<a name="line.145"></a>
<FONT color="green">146</FONT>        public PrintWriter getLogWriter() {<a name="line.146"></a>
<FONT color="green">147</FONT>            return logWriter;<a name="line.147"></a>
<FONT color="green">148</FONT>        }<a name="line.148"></a>
<FONT color="green">149</FONT>        <a name="line.149"></a>
<FONT color="green">150</FONT>        /**<a name="line.150"></a>
<FONT color="green">151</FONT>         * Sets the log writer to be used by this configuration to log<a name="line.151"></a>
<FONT color="green">152</FONT>         * information on abandoned objects.<a name="line.152"></a>
<FONT color="green">153</FONT>         * <a name="line.153"></a>
<FONT color="green">154</FONT>         * @param logWriter The new log writer<a name="line.154"></a>
<FONT color="green">155</FONT>         */<a name="line.155"></a>
<FONT color="green">156</FONT>        public void setLogWriter(PrintWriter logWriter) {<a name="line.156"></a>
<FONT color="green">157</FONT>            this.logWriter = logWriter;<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    }<a name="line.159"></a>




























































</PRE>
</BODY>
</HTML>
